Macros
#define	SY_EXTENDFILENOTSUPPORTED

#define	SY_PATHSEPARATOR '/'

#define	SYFile int

#define	syInvalidateFile(_f) *_f = ERROR

#define	syIsValidFile(_file) (_file!=ERROR)

#define	syInvalidFile() (ERROR)

#define	SY_CP_FIRSTILLEGALCHAR {0xe5}

#define	SY_CP_ANYILLEGALCHAR {0x7c, 0x5c}

#define	syFlushFile(_file) ((fsync(_file)==OK)? NQ_SUCCESS:NQ_FAIL)

#define	syGetSecurityDescriptor(_f, _i, _b) udGetSecurityDescriptor(_f, _i, _b)

#define	sySetSecurityDescriptor(_f, _i, _b, _l) udSetSecurityDescriptor(_f, _i, _b, _l)

Functions
SYFile	syCreateFile (const NQ_WCHAR *name, NQ_BOOL denyread, NQ_BOOL denyexecute, NQ_BOOL denywrite)

NQ_STATUS	syDeleteFile (const NQ_WCHAR *name)

NQ_STATUS	syRenameFile (const NQ_WCHAR oldName, const NQ_WCHAR newName)

SYFile	syOpenFileForRead (const NQ_WCHAR *name, NQ_BOOL denyread, NQ_BOOL denyexecute, NQ_BOOL denywrite)

SYFile	syOpenFileForWrite (const NQ_WCHAR *name, NQ_BOOL denyread, NQ_BOOL denyexecute, NQ_BOOL denywrite)

SYFile	syOpenFileForReadWrite (const NQ_WCHAR *name, NQ_BOOL denyread, NQ_BOOL denyexecute, NQ_BOOL denywrite)

NQ_STATUS	syTruncateFile (SYFile file, NQ_UINT32 offLow, NQ_UINT32 offHigh)

NQ_INT	syReadFile (SYFile file, NQ_BYTE *buf, NQ_COUNT len)

NQ_INT	syWriteFile (SYFile file, const NQ_BYTE *buf, NQ_COUNT len)

NQ_STATUS	syCloseFile (SYFile fd)

NQ_UINT32	sySeekFileCurrent (SYFile file, NQ_INT32 off, NQ_INT32 offHigh)

NQ_UINT32	sySeekFileStart (SYFile file, NQ_UINT32 off, NQ_UINT32 offHigh)

NQ_UINT32	sySeekFileEnd (SYFile file, NQ_INT32 off, NQ_INT32 offHigh)

NQ_STATUS	syGetFileInformation (SYFile file, const NQ_WCHAR fileName, SYFileInformation fileInfo)

NQ_STATUS	syGetFileInformationByName (const NQ_WCHAR fileName, SYFileInformation fileInfo)

NQ_STATUS	syGetFileSize (SYFile file, NQ_UINT64 *size)

NQ_STATUS	sySetFileInformation (const NQ_WCHAR fileName, SYFile handle, const SYFileInformation fileInfo)

NQ_STATUS	syGetVolumeInformation (const NQ_WCHAR name, SYVolumeInformation info)

Detailed Description

Macro Definition Documentation

#define SY_EXTENDFILENOTSUPPORTED

On some platforms ftruncate() might not support extending file. In this case open this define to simulate extending files

#define SY_PATHSEPARATOR '/'

Path separator character

#define SYFile int

File handle

#define syInvalidateFile ( _f ) *_f = ERROR

Set invalid file handle

#define syIsValidFile ( _file ) (_file!=ERROR)

Check file handle

#define syInvalidFile ( ) (ERROR)

#define SY_CP_FIRSTILLEGALCHAR {0xe5}

Characters which are not acceptable by the file system as a file name

#define SY_CP_ANYILLEGALCHAR {0x7c, 0x5c}

Characters which are not acceptable by the file system as a file name

#define syFlushFile ( _file ) ((fsync(_file)==OK)? NQ_SUCCESS:NQ_FAIL)

#define syGetSecurityDescriptor	(	_f,
		_i,
		_b
	)	udGetSecurityDescriptor(_f, _i, _b)

This function is actually user-defined. These macros are used for properly redefining file descriptors

#define sySetSecurityDescriptor	(	_f,
		_i,
		_b,
		_l
	)	udSetSecurityDescriptor(_f, _i, _b, _l)

This function is actually user-defined. These macros are used for properly redefining file descriptors

Function Documentation

SYFile syCreateFile	(	const NQ_WCHAR *	name,
		NQ_BOOL	denyread,
		NQ_BOOL	denyexecute,
		NQ_BOOL	denywrite
	)

Create and open new file

Parameters

name	File name
denyread	True - to deny sharing for read
denyexecute	True - to deny sharing for execute
denywrite	True - to deny sharing for write

Returns: File handle or invalid handle

NQ_STATUS syDeleteFile ( const NQ_WCHAR * name )

Delete file

Parameters

name File name

Returns: NQ_SUCCESS or NQ_FAIL

NQ_STATUS syRenameFile	(	const NQ_WCHAR *	oldName,
		const NQ_WCHAR *	newName
	)

Rename file

Parameters

oldName	File name
newName	New file name

Returns: NQ_SUCCESS or NQ_FAIL

SYFile syOpenFileForRead	(	const NQ_WCHAR *	name,
		NQ_BOOL	denyread,
		NQ_BOOL	denyexecute,
		NQ_BOOL	denywrite
	)

Open file for reading

Parameters

name	File name
denyread	True - to deny sharing for read
denyexecute	True - to deny sharing for execute
denywrite	True - to deny sharing for write

Returns: File handle or invalid handle

SYFile syOpenFileForWrite	(	const NQ_WCHAR *	name,
		NQ_BOOL	denyread,
		NQ_BOOL	denyexecute,
		NQ_BOOL	denywrite
	)

Open file for writing

Parameters

name	File name
denyread	True - to deny sharing for read
denyexecute	True - to deny sharing for execute
denywrite	True - to deny sharing for write

Returns: File handle or invalid handle

SYFile syOpenFileForReadWrite	(	const NQ_WCHAR *	name,
		NQ_BOOL	denyread,
		NQ_BOOL	denyexecute,
		NQ_BOOL	denywrite
	)

Open file for reading and writing

Parameters

name	File name
denyread	True - to deny sharing for read
denyexecute	True - to deny sharing for execute
denywrite	True - to deny sharing for write

Returns: File handle or invalid handle

NQ_STATUS syTruncateFile	(	SYFile	file,
		NQ_UINT32	offLow,
		NQ_UINT32	offHigh
	)

Truncate file

Parameters

file	File handle
offLow	Offset low
offHigh	Offset high

Returns: NQ_SUCCESS or NQ_FAIL

NQ_INT syReadFile	(	SYFile	file,
		NQ_BYTE *	buf,
		NQ_COUNT	len
	)

Read bytes from file

Parameters

file	File handle
buf	Buffer for data
len	Number of bytes to read

Returns: Number of bytes read, zero on end of file, or NQ_FAIL

NQ_INT syWriteFile	(	SYFile	file,
		const NQ_BYTE *	buf,
		NQ_COUNT	len
	)

Write bytes into file

Parameters

file	File handle
buf	Bytes to write
len	Number of bytes to write

Returns: Number of bytes written or NQ_FAIL

NQ_STATUS syCloseFile ( SYFile fd )

Close opened file

Parameters

fd	Handle of the file

Returns: NQ_SUCCESS if the file was close or NQ_FAIL on error

NQ_UINT32 sySeekFileCurrent	(	SYFile	file,
		NQ_INT32	off,
		NQ_INT32	offHigh
	)

Position file relatively from the current position

Parameters

file	File handle
off	Low 32 bits of the offset
offHigh	High 32 bits of the offset

Returns: New file position or NQ_FAIL

NQ_UINT32 sySeekFileStart	(	SYFile	file,
		NQ_UINT32	off,
		NQ_UINT32	offHigh
	)

Position file from the beginning

Parameters

file	File handle
off	Low 32 bits of the offset
offHigh	High 32 bits of the offset

Returns: New file position or NQ_FAIL

NQ_UINT32 sySeekFileEnd	(	SYFile	file,
		NQ_INT32	off,
		NQ_INT32	offHigh
	)

Position file from the end

Parameters

file	File handle
off	Low 32 bits of the offset
offHigh	High 32 bits of the offset

Returns: New file position or NQ_FAIL

NQ_STATUS syGetFileInformation	(	SYFile	file,
		const NQ_WCHAR *	fileName,
		SYFileInformation *	fileInfo
	)

Read file information structure by file handle

Parameters

file	File id
fileName	File name
fileInfo	File information structure

Returns: NQ_SUCCESS or NQ_FAIL

NQ_STATUS syGetFileInformationByName	(	const NQ_WCHAR *	fileName,
		SYFileInformation *	fileInfo
	)

Read file information structure by file name

Parameters

fileName	File name
fileInfo	File information structure

Returns: NQ_SUCCESS or NQ_FAIL

NQ_STATUS syGetFileSize	(	SYFile	file,
		NQ_UINT64 *	size
	)

Read file size by file handle

Parameters

file	File id
size	File size

Returns: NQ_SUCCESS or NQ_FAIL

NQ_STATUS sySetFileInformation	(	const NQ_WCHAR *	fileName,
		SYFile	handle,
		const SYFileInformation *	fileInfo
	)

Update file information by either file name or file handle

Parameters

fileName	File name
handle	File handle
fileInfo	File information structure

Returns: NQ_SUCCESS or NQ_FAIL

NQ_STATUS syGetVolumeInformation	(	const NQ_WCHAR *	name,
		SYVolumeInformation *	info
	)

Query volume information

Parameters

name	Volume name
info	Buffer for information

Returns: NQ_SUCCESS or NQ_FAIL

Macros

Functions

Detailed Description

Macro Definition Documentation

Function Documentation